<!DOCTYPE html>
<html lang="en">
  <head>
    <title>HYPSnapshotContainer Protocol Reference</title>
    <link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
    <link rel="stylesheet" type="text/css" href="../css/highlight.css" />
    <meta charset='utf-8'>
    <script src="../js/jquery.min.js" defer></script>
    <script src="../js/jazzy.js" defer></script>
    
    <script src="../js/lunr.min.js" defer></script>
    <script src="../js/typeahead.jquery.js" defer></script>
    <script src="../js/jazzy.search.js" defer></script>
  </head>
  <body>
    <a name="//apple_ref/objc/Protocol/HYPSnapshotContainer" class="dashAnchor"></a>
    <a title="HYPSnapshotContainer Protocol Reference"></a>
    <header>
      <div class="content-wrapper">
        <p><a href="../index.html">HyperionCore 0.99.0 Docs</a> (94% documented)</p>
        <p class="header-right"><a href="https://github.com/willowtreeapps/Hyperion-iOS"><img src="../img/gh.png"/>View on GitHub</a></p>
        <p class="header-right">
          <form role="search" action="../search.json">
            <input type="text" placeholder="Search documentation" data-typeahead>
          </form>
        </p>
      </div>
    </header>
    <div class="content-wrapper">
      <p id="breadcrumbs">
        <a href="../index.html">HyperionCore Reference</a>
        <img id="carat" src="../img/carat.png" />
        HYPSnapshotContainer Protocol Reference
      </p>
    </div>
    <div class="content-wrapper">
      <nav class="sidebar">
        <ul class="nav-groups">
          <li class="nav-group-name">
            <a href="../Classes.html">Classes</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a href="../Classes/HYPPluginHelper.html">HYPPluginHelper</a>
              </li>
              <li class="nav-group-task">
                <a href="../Classes/HYPPluginMenuItem.html">HYPPluginMenuItem</a>
              </li>
              <li class="nav-group-task">
                <a href="../Classes.html#/c:objc(cs)HYPPluginModule">HYPPluginModule</a>
              </li>
              <li class="nav-group-task">
                <a href="../Classes/HYPSnapshotInteractionView.html">HYPSnapshotInteractionView</a>
              </li>
              <li class="nav-group-task">
                <a href="../Classes/HYPSnapshotPluginModule.html">HYPSnapshotPluginModule</a>
              </li>
              <li class="nav-group-task">
                <a href="../Classes/HyperionManager.html">HyperionManager</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a href="../Constants.html">Constants</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a href="../Constants.html#/c:@HyperionCoreVersionNumber">HyperionCoreVersionNumber</a>
              </li>
              <li class="nav-group-task">
                <a href="../Constants.html#/c:@HyperionCoreVersionString">HyperionCoreVersionString</a>
              </li>
              <li class="nav-group-task">
                <a href="../Constants.html#/c:@pluginMenuItem">pluginMenuItem</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a href="../Protocols.html">Protocols</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a href="../Protocols/HYPOverlayContainer.html">HYPOverlayContainer</a>
              </li>
              <li class="nav-group-task">
                <a href="../Protocols/HYPOverlayPluginViewProvider.html">HYPOverlayPluginViewProvider</a>
              </li>
              <li class="nav-group-task">
                <a href="../Protocols/HYPPlugin.html">HYPPlugin</a>
              </li>
              <li class="nav-group-task">
                <a href="../Protocols/HYPPluginExtension.html">HYPPluginExtension</a>
              </li>
              <li class="nav-group-task">
                <a href="../Protocols/HYPPluginMenuItem.html">HYPPluginMenuItem</a>
              </li>
              <li class="nav-group-task">
                <a href="../Protocols/HYPPluginMenuItemDelegate.html">HYPPluginMenuItemDelegate</a>
              </li>
              <li class="nav-group-task">
                <a href="../Protocols/HYPPluginModule.html">HYPPluginModule</a>
              </li>
              <li class="nav-group-task">
                <a href="../Protocols/HYPSnapshotContainer.html">HYPSnapshotContainer</a>
              </li>
              <li class="nav-group-task">
                <a href="../Protocols/HYPSnapshotPluginViewProvider.html">HYPSnapshotPluginViewProvider</a>
              </li>
              <li class="nav-group-task">
                <a href="../Protocols/HYPViewSelectionDelegate.html">HYPViewSelectionDelegate</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a href="../Functions.html">Functions</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a href="../Functions.html#/c:@F@NS_OPTIONS">NS_OPTIONS</a>
              </li>
            </ul>
          </li>
        </ul>
      </nav>
      <article class="main-content">
        <section>
          <section class="section">
            <h1>HYPSnapshotContainer</h1>
              <div class="declaration">
                <div class="language">
                  
                  <pre class="highlight objective_c"><code><span class="k">@protocol</span> <span class="nc">HYPSnapshotContainer</span></code></pre>

                </div>
              </div>
            <p>The HYPSnapshotContainer provides a mechanism of displaying custom UI over a Snapshot of the current app. This allows the user to zoom on the app and inspect tiny details, but also prevents the user from interacting with the app. The HYPSnapshotContainer holds the HYPSnapshotPluginViewProvider&rsquo;s view when a snapshot plugin becomes active. It also provides convenience methods for presenting common UI across the Snanshot plugin platform.</p>

              <div class="slightly-smaller">
                <a href="https://github.com/willowtreeapps/Hyperion-iOS/tree/master//Core/Public/Plugin/HYPOverlayContainer.h#L32-L80">Show on GitHub</a>
              </div>
          </section>
          <section class="section task-group-section">
            <div class="task-group">
              <ul>
                <li class="item">
                  <div>
                    <code>
                    <a name="/c:objc(pl)HYPSnapshotContainer(im)presentViewListPopoverForPoint:delegate:"></a>
                    <a name="//apple_ref/objc/Method/-presentViewListPopoverForPoint:delegate:" class="dashAnchor"></a>
                    <a class="token" href="#/c:objc(pl)HYPSnapshotContainer(im)presentViewListPopoverForPoint:delegate:">-presentViewListPopoverForPoint:<wbr>delegate:<wbr></a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>This presents a popover view controller with a list a views that intersect with the provided point. The views listed are in order of front to back.</p>

<p>Note: This is used to select views that are covered by other views. This is typically called after a long press gesture on a certain point, but it is up to the plugin to decide when to present this.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Objective-C</p>
                          <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">presentViewListPopoverForPoint</span><span class="p">:(</span><span class="n">id</span><span class="p">)</span><span class="nv">point</span>
                              <span class="nf">delegate</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">id</span><span class="o">&lt;</span><span class="n"><a href="../Protocols/HYPViewSelectionDelegate.html">HYPViewSelectionDelegate</a></span><span class="o">&gt;</span><span class="p">)</span>
                                           <span class="n">delegate</span><span class="p">;</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>point</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The point at which the popover presents itself.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>delegate</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The delegate that notifies when a view has been selected.</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/willowtreeapps/Hyperion-iOS/tree/master//Core/Public/Plugin/HYPOverlayContainer.h#L41">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/c:objc(pl)HYPSnapshotContainer(im)presentPopover:recommendedHeight:forView:"></a>
                    <a name="//apple_ref/objc/Method/-presentPopover:recommendedHeight:forView:" class="dashAnchor"></a>
                    <a class="token" href="#/c:objc(pl)HYPSnapshotContainer(im)presentPopover:recommendedHeight:forView:">-presentPopover:<wbr>recommendedHeight:<wbr>forView:<wbr></a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>This presents a popover containing the view controller provided.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Objective-C</p>
                          <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">presentPopover</span><span class="p">:(</span><span class="n">id</span><span class="p">)</span><span class="nv">popoverController</span>
     <span class="nf">recommendedHeight</span><span class="p">:(</span><span class="n">id</span><span class="p">)</span><span class="nv">height</span>
               <span class="nf">forView</span><span class="p">:(</span><span class="n">id</span><span class="p">)</span><span class="nv">view</span><span class="p">;</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>popoverController</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The view controller to display inside the popover.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>height</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The requested height to make the popover. This value caps out at 300.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>view</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The view at which the popover should present itself around.</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/willowtreeapps/Hyperion-iOS/tree/master//Core/Public/Plugin/HYPOverlayContainer.h#L49">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/c:objc(pl)HYPSnapshotContainer(im)presentPopover:recommendedHeight:atPosition:"></a>
                    <a name="//apple_ref/objc/Method/-presentPopover:recommendedHeight:atPosition:" class="dashAnchor"></a>
                    <a class="token" href="#/c:objc(pl)HYPSnapshotContainer(im)presentPopover:recommendedHeight:atPosition:">-presentPopover:<wbr>recommendedHeight:<wbr>atPosition:<wbr></a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>This presents a popover containing the view controller provided.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Objective-C</p>
                          <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">presentPopover</span><span class="p">:(</span><span class="n">id</span><span class="p">)</span><span class="nv">popoverController</span>
     <span class="nf">recommendedHeight</span><span class="p">:(</span><span class="n">id</span><span class="p">)</span><span class="nv">height</span>
            <span class="nf">atPosition</span><span class="p">:(</span><span class="n">id</span><span class="p">)</span><span class="nv">point</span><span class="p">;</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>popoverController</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The view controller to display inside the popover.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>height</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The requested height to make the popover. This value caps out at 300.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>point</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The position at which the popover should present itself.</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/willowtreeapps/Hyperion-iOS/tree/master//Core/Public/Plugin/HYPOverlayContainer.h#L57">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/c:objc(pl)HYPSnapshotContainer(im)dismissCurrentPopover"></a>
                    <a name="//apple_ref/objc/Method/-dismissCurrentPopover" class="dashAnchor"></a>
                    <a class="token" href="#/c:objc(pl)HYPSnapshotContainer(im)dismissCurrentPopover">-dismissCurrentPopover</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Dismisses the current popover if there is one.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Objective-C</p>
                          <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="n">dismissCurrentPopover</span><span class="p">;</span></code></pre>

                        </div>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/willowtreeapps/Hyperion-iOS/tree/master//Core/Public/Plugin/HYPOverlayContainer.h#L62">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/c:objc(pl)HYPSnapshotContainer(im)presentViewController:animated:"></a>
                    <a name="//apple_ref/objc/Method/-presentViewController:animated:" class="dashAnchor"></a>
                    <a class="token" href="#/c:objc(pl)HYPSnapshotContainer(im)presentViewController:animated:">-presentViewController:<wbr>animated:<wbr></a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Presents a view controller modally over the snapshot container.</p>

<p>Note: This is typically used when a popover does not provide enough real estate for the information being displayed.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Objective-C</p>
                          <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">presentViewController</span><span class="p">:(</span><span class="n">id</span><span class="p">)</span><span class="nv">controller</span> <span class="nf">animated</span><span class="p">:(</span><span class="n">id</span><span class="p">)</span><span class="nv">animated</span><span class="p">;</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>controller</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The ViewController to present modally.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>animated</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>Whether or not the presentation is animated.</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/willowtreeapps/Hyperion-iOS/tree/master//Core/Public/Plugin/HYPOverlayContainer.h#L71">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/c:objc(pl)HYPSnapshotContainer(py)overlayModule"></a>
                    <a name="//apple_ref/objc/Property/overlayModule" class="dashAnchor"></a>
                    <a class="token" href="#/c:objc(pl)HYPSnapshotContainer(py)overlayModule">overlayModule</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>The current active plugin module.</p>

<p>Note: This can be set to nil to deactivate the current plugin.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Objective-C</p>
                          <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">id</span><span class="o">&lt;</span><span class="n"><a href="../Protocols/HYPPluginModule.html">HYPPluginModule</a></span><span class="p">,</span> <span class="n"><a href="../Protocols/HYPSnapshotPluginViewProvider.html">HYPSnapshotPluginViewProvider</a></span><span class="o">&gt;</span> <span class="n">overlayModule</span><span class="p">;</span></code></pre>

                        </div>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/willowtreeapps/Hyperion-iOS/tree/master//Core/Public/Plugin/HYPOverlayContainer.h#L78">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
          </section>
        </section>
        <section id="footer">
          <p>&copy; 2021 <a class="link" href="http://willowtreeapps.com" target="_blank" rel="external">WillowTree</a>. All rights reserved. (Last updated: 2021-04-29)</p>
          <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
        </section>
      </article>
    </div>
  </body>
</div>
</html>
